/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.idea.gradle.model

import java.io.File

interface IdeCustomSourceDirectory {
  /**
   * Source name as represented to the user.
   *
   * The Android Gradle Plugin will enforce that each custom type registration is unique and used only once
   * within each Gradle (sub)project.
   *
   * Names are expected to be reused across Gradle (sub)projects, in general by the build author applying the
   * same custom plugin to multiple projects within a single or composite Gradle build. In theory, different
   * plugins could register custom source types of the same name, which would not be a problem as long as
   * only one of those plugins is applied to any particular project within the build.
   */
  val sourceTypeName: String

  /** The single source folder for the source type. */
  val directory: File
}